Resource URL: /platform/<<version=3>>/cluster/nodes/<LNN>/drives-purposelist

    Overview: This resource provides a list of the purposeswhich can be applied
              to drives in this node.  The list also contains a description of
              each possible drive purpose.

     Methods: GET

********************************************************************************

Method GET: Lists the available purposes for drives in this node.

       URL: GET /platform/<<version=3>>/cluster/nodes/<LNN>/drives-purposelist

There are no query arguments for this method.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "type": "object", 
      "properties": {
        "total": {
          "type": "integer", 
          "description": "The total number of nodes responding."
        }, 
        "nodes": {
          "items": {
            "type": "object", 
            "description": "Information about this node's drive purposes.", 
            "properties": {
              "purposes": {
                "items": {
                  "type": "object", 
                  "description": "Purpose information.", 
                  "properties": {
                    "purpose": {
                      "type": "string", 
                      "description": "String representation of this purpose for API use."
                    }, 
                    "purpose_description": {
                      "type": "string", 
                      "description": "A description of this purpose."
                    }
                  }
                }, 
                "type": "array", 
                "description": "List of the drive purposes available on this node."
              }, 
              "status": {
                "required": false, 
                "minimum": 0, 
                "type": "integer", 
                "description": "Status of the HTTP response from this node if not 200.  If 200, this field does not appear.", 
                "maximum": 4294967295
              }, 
              "lnn": {
                "minimum": 0, 
                "type": "integer", 
                "description": "Logical node number of the node reporting this information.", 
                "maximum": 4294967295
              }, 
              "id": {
                "minimum": 0, 
                "type": "integer", 
                "description": "Node ID of the node reporting this information.", 
                "maximum": 4294967295
              }, 
              "error": {
                "required": false, 
                "type": "string", 
                "description": "Error message, if the HTTP status returned from this node was not 200."
              }
            }
          }, 
          "type": "array", 
          "description": "The responses from the individual nodes involved in this request."
        }, 
        "errors": {
          "items": {
            "type": "object", 
            "properties": {
              "status": {
                "minimum": 0, 
                "type": "integer", 
                "description": "HTTP Status code returned by this node.", 
                "maximum": 4294967295
              }, 
              "message": {
                "type": "string", 
                "description": "More detailed description of the error."
              }, 
              "code": {
                "type": "string", 
                "description": "The general meaning of the status code."
              }, 
              "lnn": {
                "minimum": 0, 
                "type": "integer", 
                "description": "Logical node number of the node reporting this error.", 
                "maximum": 4294967295
              }
            }
          }, 
          "type": "array", 
          "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors."
        }
      }
    }
  ]
}
